@bicycle-codes/simple-aes
Advanced tools
Cryptography used by vanishing.page. Works in browsers and node.
This is generally useful as a dead simple way of working with symmetric keys in a browser or node.
Thanks to Fission, the original author for much of this code.
npm i -S @bicycle-codes/simple-aes
Just import
import {
decryptMessage,
encryptMessage,
type Message
} from '@bicycle-codes/simple-aes'
// } from '@bicycle-codes/simple-aes/compat' // for older browsers
This exposes pre-bundled & minified JS files.
cp ./node_modules/@bicycle-codes/simple-aes/dist/compat.min.js ./public
cp ./node_modules/@bicycle-codes/simple-aes/dist/index.min.js ./public/simple-aes.min.js
<body>
<!-- ... -->
<script type="module" src="./compat.min.js"></script>
<!-- or webcrypto version -->
<script type="module" src="./simple-aes.min.js"></script>
</body>
@bicycle-codes/simple-aesUse the webcrypto API. This will only work in newer browsers.
import {
decryptMessage,
encryptMessage,
type Message
} from '@bicycle-codes/simple-aes'
@bicycle-codes/simple-aes/compatUse a user-land module, @noble/ciphers. This will work in browsers of all ages.
import {
encryptMessage,
decryptMessage
} from '@bicycle-codes/simple-aes/compat'
encryptMessageGenerate a new AES key and encrypt the given message object.
Return an array of [ encryptedMessage, { key }],
where key is a new AES key, encoded as base64url.
async function encryptMessage (
msg:{ content:string }
):Promise<[{ content:string }, { key }]>
import { encryptMessage } from '@bicycle-codes/simple-aes'
const [encryptedMsg, { key }] = await encryptMessage({
content: 'hello world'
})
console.log(encryptedMessage)
// => { content: '5eAcA6+jnBfbuCx8L...' }
decryptMessageDecrypt the given message with the given key. Suitable for decrypting a message that was encrypted by this library. Key is an AES key, base64url encoded.
async function decryptMessage (
msg:{ content:string },
keyString:string // <-- base64url
):Promise<{ content:string }>
import { test } from '@bicycle-codes/tapzero'
import { decryptMessage } from '@bicycle-codes/simple-aes'
test('decrypt the message', async t => {
const decrypted = await decryptMessage(message, key)
t.equal(decrypted.content, 'hello world',
'should decrypt to the right text')
})
FAQs
An easy way to use symmetric keys in browsers or node
The npm package @bicycle-codes/simple-aes receives a total of 13 weekly downloads. As such, @bicycle-codes/simple-aes popularity was classified as not popular.
We found that @bicycle-codes/simple-aes demonstrated a healthy version release cadence and project activity because the last version was released less than a year ago. It has 0 open source maintainers collaborating on the project.
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
Security News
Research
A malicious npm package disguised as a WhatsApp client is exploiting authentication flows with a remote kill switch to exfiltrate data and destroy files.
Security News
PyPI now supports digital attestations, enhancing security and trust by allowing package maintainers to verify the authenticity of Python packages.
Security News
GitHub removed 27 malicious pull requests attempting to inject harmful code across multiple open source repositories, in another round of low-effort attacks.